Please Note:

You are not viewing the most recent version of this page. 3.20(SP1) is the latest version available.

Connection endpoints

Connect

Connect(System.String,System.String,System.String@,System.String)

Connects to BlackShield or BSIDCA. Mandatory first call for using this web service. Used to authenticate an operator with permissions to use the control API. Successfully connecting will establish a management session, which will allow you to use the rest of the API. Multiple calls may be required in the case of outer window authentications, challenges or PIN changes.

Parameters

Param: OperatorEmail: Operator/Account manager e-mail to connect with.

Param: OTP: OTP or Password to connect with.

Param: challenge: Challenge message passed out if the return code requires one.

Param: validationCode: Optional e-mail validation code if the operator in use has not had their e-mail address validated.

Returns

AUTH_FAILURE	Authentication Failed
AUTH_SUCCESS	Authentication Success
CHALLENGE	A challenge has been returned in the challenge argument. Call this function again with the response in the OTP argument.
SERVER_PIN_PROVIDED	The server has initiated a PIN change. Your new PIN is in the challenge argument. Authenticate again using this new PIN.
USER_PIN_CHANGE	You are required call this function again providing a new PIN.
OUTER_WINDOW_AUTH	Your token is out of sync. You must call this function again with the next OTP.
CHANGE_STATIC_PASSWORD	You must call this function again and provide a new static password
STATIC_CHANGE_FAILED	Password change failed
PIN_CHANGE_FAILED	PIN change failed

SOAP 1.1 sample

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

Request:

POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.eu.safenetid.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.cryptocard.com/blackshield/Connect"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
    <Connect xmlns="http://www.cryptocard.com/blackshield/">
    <OperatorEmail>string</OperatorEmail>
    <OTP>string</OTP>
    <validationCode>string</validationCode>
    </Connect>
</soap:Body>
</soap:Envelope>

Response:

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
    <ConnectResponse xmlns="http://www.cryptocard.com/blackshield/">
    <ConnectResult>AUTH_FAILURE or AUTH_SUCCESS or CHALLENGE or SERVER_PIN_PROVIDED or USER_PIN_CHANGE or OUTER_WINDOW_AUTH or CHANGE_STATIC_PASSWORD or STATIC_CHANGE_FAILED or PIN_CHANGE_FAILED or PUSH_OTP_REJECTED or PUSH_OTP_DISPATCHED</ConnectResult>
    <challenge>string</challenge>
    </ConnectResponse>
</soap:Body>
</soap:Envelope>

SOAP 1.2 sample

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

Request:

POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.eu.safenetid.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
    <Connect xmlns="http://www.cryptocard.com/blackshield/">
    <OperatorEmail>string</OperatorEmail>
    <OTP>string</OTP>
    <validationCode>string</validationCode>
    </Connect>
</soap12:Body>
</soap12:Envelope>

Response:

sHTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
    <ConnectResponse xmlns="http://www.cryptocard.com/blackshield/">
    <ConnectResult>AUTH_FAILURE or AUTH_SUCCESS or CHALLENGE or SERVER_PIN_PROVIDED or USER_PIN_CHANGE or OUTER_WINDOW_AUTH or CHANGE_STATIC_PASSWORD or STATIC_CHANGE_FAILED or PIN_CHANGE_FAILED or PUSH_OTP_REJECTED or PUSH_OTP_DISPATCHED</ConnectResult>
    <challenge>string</challenge>
    </ConnectResponse>
</soap12:Body>
</soap12:Envelope>

PingConnection

PingConnection()

A service ping that checks the server to see if you have a valid session.

Returns

True if you have a valid connection.

SOAP 1.1 sample

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

Request:

POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.cryptocard.com/blackshield/PingConnection"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <PingConnection xmlns="http://www.cryptocard.com/blackshield/" />
  </soap:Body>
</soap:Envelope>

Response:

:::text
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <PingConnectionResponse xmlns="http://www.cryptocard.com/blackshield/">
      <PingConnectionResult>boolean</PingConnectionResult>
    </PingConnectionResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2 sample

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

Request:

POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <PingConnection xmlns="http://www.cryptocard.com/blackshield/" />
  </soap12:Body>
</soap12:Envelope>

Response:

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <PingConnectionResponse xmlns="http://www.cryptocard.com/blackshield/">
      <PingConnectionResult>boolean</PingConnectionResult>
    </PingConnectionResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

Request:

GET /bsidca/BSIDCA.asmx/PingConnection? HTTP/1.1
Host: cloud.safenet-inc.com

Response:

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<boolean xmlns="http://www.cryptocard.com/blackshield/">boolean</boolean>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

Request:

POST /bsidca/BSIDCA.asmx/PingConnection HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

Response:

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<boolean xmlns="http://www.cryptocard.com/blackshield/">boolean</boolean>